<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>Directory</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='Directory.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        Directory
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>docs&#47;includes&#47;node-pathwatcher&#47;src&#47;directory.coffee</td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Represents a directory on disk that can be watched for changes.</p>
</div>
<div class='tags'>
</div>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='Directory.html#constructor-instance'>
        ::<strong>constructor</strong>(path, symlink = false)
      </a>
    </span>
    <span class='desc'>
      Configures a new Directory instance, no files are accessed.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#contains-instance'>
        ::<strong>contains</strong>(pathToCheck)
      </a>
    </span>
    <span class='desc'>
      Returns whether the given path (real or symbolic) is inside this directory.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#getBaseName-instance'>
        ::<strong>getBaseName</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> basename of the directory.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#getEntries-instance'>
        ::<strong>getEntries</strong>(callback)
      </a>
    </span>
    <span class='desc'>
      Reads file entries in this directory from disk asynchronously.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#getEntriesSync-instance'>
        Array ::<strong>getEntriesSync</strong>()
      </a>
    </span>
    <span class='desc'>
      Reads file entries in this directory from disk synchronously.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#getPath-instance'>
        ::<strong>getPath</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns the directory&#39;s symbolic path.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#getRealPathSync-instance'>
        ::<strong>getRealPathSync</strong>()
      </a>
    </span>
    <span class='desc'>
      Returns this directory&#39;s completely resolved path.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='Directory.html#relativize-instance'>
        ::<strong>relativize</strong>(fullPath)
      </a>
    </span>
    <span class='desc'>
      Returns the relative path to the given path from this directory.
    </span>
  </li>
</ul>
      <h2>Constructor Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='constructor-instance'>
      ::<strong>constructor</strong>(path, symlink = false)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Configures a new Directory instance, no files are accessed.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(String)</span>
      <span class='name'>path</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> containing the absolute path to the directory.</span>
    </li>
    <li>
      <span class='type'>(Boolean)</span>
      <span class='name'>symlink</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean'>Boolean</a> indicating if the path is a symlink (default: false).</span>
    </li>
  </ul>
</div>
  </div>
</div>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='contains-instance'>
      ::<strong>contains</strong>(pathToCheck)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns whether the given path (real or symbolic) is inside this directory.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getBaseName-instance'>
      ::<strong>getBaseName</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String'>String</a> basename of the directory.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getEntries-instance'>
      ::<strong>getEntries</strong>(callback)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Reads file entries in this directory from disk asynchronously.</p>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='type'>(Function)</span>
      <span class='name'>callback</span>
      &mdash;
      <span class='desc'>A <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Function'>Function</a> to call with an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Error'>Error</a> as the 1st argument and an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of <a href='File.html'>File</a> and <a href='Directory.html'>Directory</a> objects as the 2nd argument.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getEntriesSync-instance'>
      Array ::<strong>getEntriesSync</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Reads file entries in this directory from disk synchronously.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      (<tt>Array</tt>)
      &mdash;
      <span class='desc'>Returns an <a href='https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array'>Array</a> of <a href='File.html'>File</a> and <a href='Directory.html'>Directory</a> objects.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPath-instance'>
      ::<strong>getPath</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the directory&#39;s symbolic path.</p><p>This may include unfollowed symlinks or relative directory entries. Or it
may be fully resolved, it depends on what you give it. </p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getRealPathSync-instance'>
      ::<strong>getRealPathSync</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns this directory&#39;s completely resolved path.</p><p>All relative directory entries are removed and symlinks are resolved to
their final destination. </p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='relativize-instance'>
      ::<strong>relativize</strong>(fullPath)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Returns the relative path to the given path from this directory.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Thu Feb 27 2014 16:02:52 GMT-0800 (PST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.0
  (Node.js v0.10.21).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>